home *** CD-ROM | disk | FTP | other *** search
/ Pascal Super Library / Pascal Super Library (CW International)(1997).bin / DELPHI32 / DEBUG / DTRACE32 / README.TXT < prev    next >
Text File  |  1996-09-24  |  5KB  |  140 lines
  1. DTRACE32
  2.  
  3. Usage
  4. -----
  5.  
  6. Start DTRACE32 and it registers itself to the Win95/NT40 Task-Tray. By clicking
  7. on its icon you open the main-form with a list of all events occured so far.
  8. By double-clicking on the tray-icon the main-form hides again.
  9.  
  10. Debug messages can be sent with three levels of severity:
  11.  
  12. Information,Warning and Error
  13.  
  14. The levels are represented by tiny icons known from the NT Event Viewer.
  15.  
  16. If you click on an event, you get detailed information about the event in the statusbar
  17. of DTrace32. If no MAP-file is available, the name of the calling application, the address of the calling routine and the timestamp of the message are displayed.
  18.  
  19. If a detailed MAP-file exists, the name of the calling procedure, the modulename where the procedure
  20. can be found and the line-number in the module are displayed also.
  21.  
  22.  
  23. To send debug-messages simply include the unit UTRACE in the module you want to monitor and use
  24. the procedures provided by the dll. The procedures are always present in two forms,
  25. a standard form that simply displays a text and a *fmt version that accepts format strings
  26. as used in StrFmt and FmtStr.
  27.  
  28. The units provides you with the following functions:
  29.  
  30.     procedure Assert(Condition : Boolean;TheText : String);
  31.     procedure AssertFmt(Condition : Boolean;TheFormat : String;const Args: Array of const);
  32.  
  33. Assertation functions as known in C
  34.  
  35. if the condition used is false, a debugmessage is sent and the program stops.
  36.  
  37.     procedure DebugDump(TheText : String;Address : Pointer;Count : Integer);
  38.  
  39. Dumps a hex-dump to DTrace32
  40.  
  41.     procedure DebugInfo(TheText : String);
  42.     procedure DebugInfoFmt(TheFormat : String;const Args: Array of const);
  43.  
  44. Sends messages of class information to DTrace32
  45.  
  46.     procedure DebugWarn(TheText : String);
  47.     procedure DebugWarnFmt(TheFormat : String;const Args: Array of const);
  48.  
  49. Sends messages of class warning to DTrace32
  50.  
  51.     procedure DebugErr(TheText : String);
  52.     procedure DebugErrFmt(TheFormat : String;const Args: Array of const);
  53.  
  54. Sends messages of class error to DTrace32
  55.  
  56.     procedure Debug(TheSeverity : TDebugSeverity;TheText : String);
  57.     procedure DebugFmt(TheSeverity : TDebugSeverity;TheFormat : String;const Args: Array of const);
  58.  
  59. 'low level' ;-) message functions
  60.  
  61.  
  62. DTrace32 works with windowed applications and with console applications too.
  63.  
  64. There also exists a unit UNOTRACE that can be included instead of UTRACE to quickly turn of
  65. Debug-messages for a unit. 
  66.  
  67. This Unit consists of the same procedures but does not do anything.
  68.  
  69. Please note: if your application goes final you should remove all references to procedures 
  70. of the UTrace and UNoTrace. Even if the procedures in UNoTrace do nothing, Delphi still puts all 
  71. parameters on the stack when it calls the (do-nothing) procedures.
  72.  
  73. Comments
  74. --------
  75.  
  76. I am eagerly awaiting your comments on how to improve this application. I have not included the
  77. source-code of the DTRACE32 Application itself because it uses other components that i have written
  78. (SavePosition, AddToTray ...) that are not 100% ready for distribution. If you are interested in the
  79. complete source code and want to beta-test the components, please drop me a line, i will be happy
  80. to send you the complete source-code. 
  81.  
  82. Contacting the author
  83. ---------------------
  84.  
  85. I can be contacted via e-mail:
  86.  
  87. ring@abo.rhein-zeitung.de
  88.  
  89. or 
  90.  
  91. 71042,105@compuserve.com (or so...)
  92.  
  93. please note, that ring@abo.rhein-zeitung.de will be disabled in Nov or Dec 1996 because i will move 
  94. to another city soon. I will post an update of the application as soon as i have my new (final???)
  95. internet-address.
  96.  
  97.  
  98. {start paste}
  99.  
  100. Distribution
  101. ------------
  102.  
  103. You are hereby licensed to make as many copies of DTRACE32
  104. as you wish and provide them to anyone as long as: the
  105. DTRACE32 distribution is not modified in any way, and you
  106. do not charge any money for any of the copies of DTRACE32
  107. you make.  If you wish to include DTRACE32 in any sort of
  108. distribution that will be sold commercially or otherwise,
  109. you must get written permission from the author.
  110. A small royalty may be charged depending on the nature of 
  111. the distribution.
  112.  
  113. All rights not expressly granted are reserved to Michael Ring.
  114.  
  115.  
  116.  
  117. Disclaimer
  118. ----------
  119.  
  120. THE INFORMATION, CODE AND EXECUTABLES PROVIDED ARE PROVIDED
  121. AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
  122. INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
  123. MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO
  124. EVENT SHALL MICHAEL RING BE LIABLE FOR ANY DAMAGES WHATSOEVER 
  125. INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS 
  126. OF BUSINESS PROFITS, OR SPECIAL DAMAGES, EVEN IF MICHAEL RING
  127. HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  128.  
  129. {end paste}   ;-)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.